Scripting SetPoint Properties
A special category of script properties exist within the SetPoint Button tool that allows scripting access to the configuration settings of the SetPoint Button for the following objects: TargetTag, DefaultValue, Prompt, and Status.
These objects contain several properties and functions like other CygNet COM objects, however they can only be accessed within the CygNet Studio Microsoft Visual Basic scripting environment. These objects cannot be created and must be accessed in the same way you would access properties and functions on other CygNet Studio controls. They hold configuration information that mimics the User Interface (UI) available on the [SetPoint] property configuration pages of the SetPoint Button tool. Any value that can be viewed or edited in the [SetPoint] UI can be changed via script for the SetPoint Button tool.
These objects also support the built-in Microsoft IntelliSense options (parameter info, quick info, complete word, etc.) available in other CygNet Studio tools.
These objects could be used in the case where some default configuration has been set in the [SetPoint] UI, and those settings could be verified or changed via script within the PreSetPoint and PostSetPoint events before and after a SetPoint operation. Alternatively, a script could be written to configure all the properties for the [SetPoint] UI, and then execute the SetPoint operation using the RunClick function within the SetPoint Button control.
TargetTag
TargetTag contains the following properties, which correspond to the Target point settings on the General page of the SetPoint Properties dialog box:
- FacilityId
- FullyQualifiedTag
- OverrideFacilityId
- OverrideSiteService
- OverrideUdc
- ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method:
- Facility
- IsValid (method)
- LongPointID
- PointID
- Site
- Service
- SiteService
- Tag
- UDC
DefaultValue
DefaultValue contains the following properties, which correspond to the Value, Timestamp, and Unreliable bit settings on the Default Value page of the SetPoint Properties dialog box:
- AlternatePointValue — The AlternatePointValue object contains the same set of properties as TargetTag:
SetPointButton.DefaultValue.AlternatePointValue. properties
- FacilityId
- FullyQualifiedTag
- OverrideFacilityId
- OverrideSiteService
- OverrideUdc
- ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method:
- Facility
- IsValid (method)
- LongPointID
- PointID
- Site
- Service
- SiteService
- Tag
- UDC
- ClearUnreliableBit
- CustomTimestamp
- CustomTimeStampAsDate
- EnforcePointDataType
- ModifyPointValue
- PointAttributeValue
- PointDataType
- PreserveUnreliableBit
- SetUnreliableBit
- SpecificValue
- UseAlternatePointValue
- UseCurrentTimestamp
- UseCustomTimestamp
- UsePointAttributeValue
- UseSpecificValue
Prompt
Prompt contains the following properties, which correspond to the Caption, Confirm and Cancel buttons, Displayed items, and Analog settings on the Prompt page of the SetPoint Properties dialog box:
- AnalogMaximumPoint — The AnalogMaximumPoint object contains the same set of properties as TargetTag:
- FacilityId
- FullyQualifiedTag
- OverrideFacilityId
- OverrideSiteService
- OverrideUdc
- ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method:
- Facility
- IsValid (method)
- LongPointID
- PointID
- Site
- Service
- SiteService
- Tag
- UDC
- AnalogMaximumSpecificValue
- AnalogMinimumPoint — The AnalogMaximumPoint object contains the same set of properties as TargetTag:
- FacilityId
- FullyQualifiedTag
- OverrideFacilityId
- OverrideSiteService
- OverrideUdc
- ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method:
- Facility
- IsValid (method)
- LongPointID
- PointID
- Site
- Service
- SiteService
- Tag
- UDC
- AnalogMinimumSpecificValue
- AnalogSliderIncrement
- BackColor
- CancelBackColor
- CancelCaption
- CancelFont
- CancelForeColor
- Caption
- ConfirmBackColor
- ConfirmCaption
- ConfirmFont
- ConfirmForeColor
- DisplayUnits
- Message
- SpecificUnits
- TimestampDisplayStyle
- UnreliableBitDisplayStyle
- UseAnalogMaximumPoint
- UseAnalogMaximumSpecificValue
- UseAnalogMaximumTargetPoint
- UseAnalogMinimumPoint
- UseAnalogMinimumSpecificValue
- UseAnalogMinimumTargetPoint
- UseAnalogOptions
- UseAnalogSlider
- UsePrompt
- UseSpecificUnits
- UseTargetPointUnits
- ValueDisplayStyle
Status
Status contains the following properties, which correspond to the Status point, Initial value, and Advanced settings on the Status page of the SetPoint Properties dialog box:
- InitializationDelayInMilliSeconds
- InitialValue
- SetPointCompleteWhenTargetPointValueMatchesStatusCompletionValues
- SetPointCompleteWhenTargetPointValueMatchesStatusPointValue
- StatusCompletionValues
- StatusPoint — The StatusPoint object contains the same set of properties as TargetTag:
- FacilityId
- FullyQualifiedTag
- OverrideFacilityId
- OverrideSiteService
- OverrideUdc
- ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method:
- Facility
- IsValid (method)
- LongPointID
- PointID
- Site
- Service
- SiteService
- Tag
- UDC
- StatusPointEnablesDisablesButton
- TimeoutInSeconds
- ToggleManualMode
- UseInitializationDelay
- UseInitialValue
- UseStatusPoint
